home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / site.py < prev    next >
Text File  |  2008-10-05  |  14KB  |  418 lines
  1. """Append module search paths for third-party packages to sys.path.
  2.  
  3. ****************************************************************
  4. * This module is automatically imported during initialization. *
  5. ****************************************************************
  6.  
  7. In earlier versions of Python (up to 1.5a3), scripts or modules that
  8. needed to use site-specific modules would place ``import site''
  9. somewhere near the top of their code.  Because of the automatic
  10. import, this is no longer necessary (but code that does it still
  11. works).
  12.  
  13. This will append site-specific paths to the module search path.  On
  14. Unix (including Mac OSX), it starts with sys.prefix and
  15. sys.exec_prefix (if different) and appends
  16. lib/python<version>/site-packages as well as lib/site-python.
  17. On other platforms (such as Windows), it tries each of the
  18. prefixes directly, as well as with lib/site-packages appended.  The
  19. resulting directories, if they exist, are appended to sys.path, and
  20. also inspected for path configuration files.
  21.  
  22. FOR DEBIAN, this sys.path is augmented with directories in /usr/local.
  23. Local addons go into /usr/local/lib/python<version>/site-packages
  24. (resp. /usr/local/lib/site-python), Debian addons install into
  25. /usr/lib/python<version>/site-packages.
  26.  
  27. A path configuration file is a file whose name has the form
  28. <package>.pth; its contents are additional directories (one per line)
  29. to be added to sys.path.  Non-existing directories (or
  30. non-directories) are never added to sys.path; no directory is added to
  31. sys.path more than once.  Blank lines and lines beginning with
  32. '#' are skipped. Lines starting with 'import' are executed.
  33.  
  34. For example, suppose sys.prefix and sys.exec_prefix are set to
  35. /usr/local and there is a directory /usr/local/lib/python2.5/site-packages
  36. with three subdirectories, foo, bar and spam, and two path
  37. configuration files, foo.pth and bar.pth.  Assume foo.pth contains the
  38. following:
  39.  
  40.   # foo package configuration
  41.   foo
  42.   bar
  43.   bletch
  44.  
  45. and bar.pth contains:
  46.  
  47.   # bar package configuration
  48.   bar
  49.  
  50. Then the following directories are added to sys.path, in this order:
  51.  
  52.   /usr/local/lib/python2.5/site-packages/bar
  53.   /usr/local/lib/python2.5/site-packages/foo
  54.  
  55. Note that bletch is omitted because it doesn't exist; bar precedes foo
  56. because bar.pth comes alphabetically before foo.pth; and spam is
  57. omitted because it is not mentioned in either path configuration file.
  58.  
  59. After these path manipulations, an attempt is made to import a module
  60. named sitecustomize, which can perform arbitrary additional
  61. site-specific customizations.  If this import fails with an
  62. ImportError exception, it is silently ignored.
  63.  
  64. """
  65.  
  66. import sys
  67. import os
  68. import __builtin__
  69.  
  70.  
  71. def makepath(*paths):
  72.     dir = os.path.abspath(os.path.join(*paths))
  73.     return dir, os.path.normcase(dir)
  74.  
  75. def abs__file__():
  76.     """Set all module' __file__ attribute to an absolute path"""
  77.     for m in sys.modules.values():
  78.         if hasattr(m, '__loader__'):
  79.             continue   # don't mess with a PEP 302-supplied __file__
  80.         try:
  81.             m.__file__ = os.path.abspath(m.__file__)
  82.         except AttributeError:
  83.             continue
  84.  
  85. def removeduppaths():
  86.     """ Remove duplicate entries from sys.path along with making them
  87.     absolute"""
  88.     # This ensures that the initial path provided by the interpreter contains
  89.     # only absolute pathnames, even if we're running from the build directory.
  90.     L = []
  91.     known_paths = set()
  92.     for dir in sys.path:
  93.         # Filter out duplicate paths (on case-insensitive file systems also
  94.         # if they only differ in case); turn relative paths into absolute
  95.         # paths.
  96.         dir, dircase = makepath(dir)
  97.         if not dircase in known_paths:
  98.             L.append(dir)
  99.             known_paths.add(dircase)
  100.     sys.path[:] = L
  101.     return known_paths
  102.  
  103. def _init_pathinfo():
  104.     """Return a set containing all existing directory entries from sys.path"""
  105.     d = set()
  106.     for dir in sys.path:
  107.         try:
  108.             if os.path.isdir(dir):
  109.                 dir, dircase = makepath(dir)
  110.                 d.add(dircase)
  111.         except TypeError:
  112.             continue
  113.     return d
  114.  
  115. def addpackage(sitedir, name, known_paths):
  116.     """Add a new path to known_paths by combining sitedir and 'name' or execute
  117.     sitedir if it starts with 'import'"""
  118.     if known_paths is None:
  119.         _init_pathinfo()
  120.         reset = 1
  121.     else:
  122.         reset = 0
  123.     fullname = os.path.join(sitedir, name)
  124.     try:
  125.         f = open(fullname, "rU")
  126.     except IOError:
  127.         return
  128.     try:
  129.         for line in f:
  130.             if line.startswith("#"):
  131.                 continue
  132.             if line.startswith("import"):
  133.                 exec line
  134.                 continue
  135.             line = line.rstrip()
  136.             dir, dircase = makepath(sitedir, line)
  137.             if not dircase in known_paths and os.path.exists(dir):
  138.                 sys.path.append(dir)
  139.                 known_paths.add(dircase)
  140.     finally:
  141.         f.close()
  142.     if reset:
  143.         known_paths = None
  144.     return known_paths
  145.  
  146. def addsitedir(sitedir, known_paths=None):
  147.     """Add 'sitedir' argument to sys.path if missing and handle .pth files in
  148.     'sitedir'"""
  149.     if known_paths is None:
  150.         known_paths = _init_pathinfo()
  151.         reset = 1
  152.     else:
  153.         reset = 0
  154.     sitedir, sitedircase = makepath(sitedir)
  155.     if not sitedircase in known_paths:
  156.         sys.path.append(sitedir)        # Add path component
  157.     try:
  158.         names = os.listdir(sitedir)
  159.     except os.error:
  160.         return
  161.     names.sort()
  162.     for name in names:
  163.         if name.endswith(os.extsep + "pth"):
  164.             addpackage(sitedir, name, known_paths)
  165.     if reset:
  166.         known_paths = None
  167.     return known_paths
  168.  
  169. def addsitepackages(known_paths):
  170.     """Add site-packages (and possibly site-python) to sys.path"""
  171.     prefixes = [sys.prefix]
  172.     if sys.exec_prefix != sys.prefix:
  173.         prefixes.append(sys.exec_prefix)
  174.     prefixes.insert(0, '/usr/local')
  175.     for prefix in prefixes:
  176.         if prefix:
  177.             if sys.platform in ('os2emx', 'riscos'):
  178.                 sitedirs = [os.path.join(prefix, "Lib", "site-packages")]
  179.             elif os.sep == '/':
  180.                 sitedirs = [os.path.join(prefix,
  181.                                          "lib",
  182.                                          "python" + sys.version[:3],
  183.                                          "site-packages"),
  184.                             os.path.join(prefix, "lib", "site-python")]
  185.             else:
  186.                 sitedirs = [prefix, os.path.join(prefix, "lib", "site-packages")]
  187.             if sys.platform == 'darwin':
  188.                 # for framework builds *only* we add the standard Apple
  189.                 # locations. Currently only per-user, but /Library and
  190.                 # /Network/Library could be added too
  191.                 if 'Python.framework' in prefix:
  192.                     home = os.environ.get('HOME')
  193.                     if home:
  194.                         sitedirs.append(
  195.                             os.path.join(home,
  196.                                          'Library',
  197.                                          'Python',
  198.                                          sys.version[:3],
  199.                                          'site-packages'))
  200.             for sitedir in sitedirs:
  201.                 if os.path.isdir(sitedir):
  202.                     addsitedir(sitedir, known_paths)
  203.     return None
  204.  
  205.  
  206. def setBEGINLIBPATH():
  207.     """The OS/2 EMX port has optional extension modules that do double duty
  208.     as DLLs (and must use the .DLL file extension) for other extensions.
  209.     The library search path needs to be amended so these will be found
  210.     during module import.  Use BEGINLIBPATH so that these are at the start
  211.     of the library search path.
  212.  
  213.     """
  214.     dllpath = os.path.join(sys.prefix, "Lib", "lib-dynload")
  215.     libpath = os.environ['BEGINLIBPATH'].split(';')
  216.     if libpath[-1]:
  217.         libpath.append(dllpath)
  218.     else:
  219.         libpath[-1] = dllpath
  220.     os.environ['BEGINLIBPATH'] = ';'.join(libpath)
  221.  
  222.  
  223. def setquit():
  224.     """Define new built-ins 'quit' and 'exit'.
  225.     These are simply strings that display a hint on how to exit.
  226.  
  227.     """
  228.     if os.sep == ':':
  229.         eof = 'Cmd-Q'
  230.     elif os.sep == '\\':
  231.         eof = 'Ctrl-Z plus Return'
  232.     else:
  233.         eof = 'Ctrl-D (i.e. EOF)'
  234.  
  235.     class Quitter(object):
  236.         def __init__(self, name):
  237.             self.name = name
  238.         def __repr__(self):
  239.             return 'Use %s() or %s to exit' % (self.name, eof)
  240.         def __call__(self, code=None):
  241.             # Shells like IDLE catch the SystemExit, but listen when their
  242.             # stdin wrapper is closed.
  243.             try:
  244.                 sys.stdin.close()
  245.             except:
  246.                 pass
  247.             raise SystemExit(code)
  248.     __builtin__.quit = Quitter('quit')
  249.     __builtin__.exit = Quitter('exit')
  250.  
  251.  
  252. class _Printer(object):
  253.     """interactive prompt objects for printing the license text, a list of
  254.     contributors and the copyright notice."""
  255.  
  256.     MAXLINES = 23
  257.  
  258.     def __init__(self, name, data, files=(), dirs=()):
  259.         self.__name = name
  260.         self.__data = data
  261.         self.__files = files
  262.         self.__dirs = dirs
  263.         self.__lines = None
  264.  
  265.     def __setup(self):
  266.         if self.__lines:
  267.             return
  268.         data = None
  269.         for dir in self.__dirs:
  270.             for filename in self.__files:
  271.                 filename = os.path.join(dir, filename)
  272.                 try:
  273.                     fp = file(filename, "rU")
  274.                     data = fp.read()
  275.                     fp.close()
  276.                     break
  277.                 except IOError:
  278.                     pass
  279.             if data:
  280.                 break
  281.         if not data:
  282.             data = self.__data
  283.         self.__lines = data.split('\n')
  284.         self.__linecnt = len(self.__lines)
  285.  
  286.     def __repr__(self):
  287.         self.__setup()
  288.         if len(self.__lines) <= self.MAXLINES:
  289.             return "\n".join(self.__lines)
  290.         else:
  291.             return "Type %s() to see the full %s text" % ((self.__name,)*2)
  292.  
  293.     def __call__(self):
  294.         self.__setup()
  295.         prompt = 'Hit Return for more, or q (and Return) to quit: '
  296.         lineno = 0
  297.         while 1:
  298.             try:
  299.                 for i in range(lineno, lineno + self.MAXLINES):
  300.                     print self.__lines[i]
  301.             except IndexError:
  302.                 break
  303.             else:
  304.                 lineno += self.MAXLINES
  305.                 key = None
  306.                 while key is None:
  307.                     key = raw_input(prompt)
  308.                     if key not in ('', 'q'):
  309.                         key = None
  310.                 if key == 'q':
  311.                     break
  312.  
  313. def setcopyright():
  314.     """Set 'copyright' and 'credits' in __builtin__"""
  315.     __builtin__.copyright = _Printer("copyright", sys.copyright)
  316.     if sys.platform[:4] == 'java':
  317.         __builtin__.credits = _Printer(
  318.             "credits",
  319.             "Jython is maintained by the Jython developers (www.jython.org).")
  320.     else:
  321.         __builtin__.credits = _Printer("credits", """\
  322.     Thanks to CWI, CNRI, BeOpen.com, Zope Corporation and a cast of thousands
  323.     for supporting Python development.  See www.python.org for more information.""")
  324.     here = os.path.dirname(os.__file__)
  325.     __builtin__.license = _Printer(
  326.         "license", "See http://www.python.org/%.3s/license.html" % sys.version,
  327.         ["LICENSE.txt", "LICENSE"],
  328.         [os.path.join(here, os.pardir), here, os.curdir])
  329.  
  330.  
  331. class _Helper(object):
  332.     """Define the built-in 'help'.
  333.     This is a wrapper around pydoc.help (with a twist).
  334.  
  335.     """
  336.  
  337.     def __repr__(self):
  338.         return "Type help() for interactive help, " \
  339.                "or help(object) for help about object."
  340.     def __call__(self, *args, **kwds):
  341.         import pydoc
  342.         return pydoc.help(*args, **kwds)
  343.  
  344. def sethelper():
  345.     __builtin__.help = _Helper()
  346.  
  347. def aliasmbcs():
  348.     """On Windows, some default encodings are not provided by Python,
  349.     while they are always available as "mbcs" in each locale. Make
  350.     them usable by aliasing to "mbcs" in such a case."""
  351.     if sys.platform == 'win32':
  352.         import locale, codecs
  353.         enc = locale.getdefaultlocale()[1]
  354.         if enc.startswith('cp'):            # "cp***" ?
  355.             try:
  356.                 codecs.lookup(enc)
  357.             except LookupError:
  358.                 import encodings
  359.                 encodings._cache[enc] = encodings._unknown
  360.                 encodings.aliases.aliases[enc] = 'mbcs'
  361.  
  362. def setencoding():
  363.     """Set the string encoding used by the Unicode implementation.  The
  364.     default is 'ascii', but if you're willing to experiment, you can
  365.     change this."""
  366.     encoding = "ascii" # Default value set by _PyUnicode_Init()
  367.     if 0:
  368.         # Enable to support locale aware default string encodings.
  369.         import locale
  370.         loc = locale.getdefaultlocale()
  371.         if loc[1]:
  372.             encoding = loc[1]
  373.     if 0:
  374.         # Enable to switch off string to Unicode coercion and implicit
  375.         # Unicode to string conversion.
  376.         encoding = "undefined"
  377.     if encoding != "ascii":
  378.         # On Non-Unicode builds this will raise an AttributeError...
  379.         sys.setdefaultencoding(encoding) # Needs Python Unicode build !
  380.  
  381.  
  382. def execsitecustomize():
  383.     """Run custom site specific code, if available."""
  384.     try:
  385.         import sitecustomize
  386.     except ImportError:
  387.         pass
  388.  
  389.  
  390. def main():
  391.     abs__file__()
  392.     paths_in_sys = removeduppaths()
  393.     paths_in_sys = addsitepackages(paths_in_sys)
  394.     if sys.platform == 'os2emx':
  395.         setBEGINLIBPATH()
  396.     setquit()
  397.     setcopyright()
  398.     sethelper()
  399.     aliasmbcs()
  400.     setencoding()
  401.     execsitecustomize()
  402.     # Remove sys.setdefaultencoding() so that users cannot change the
  403.     # encoding after initialization.  The test for presence is needed when
  404.     # this module is run as a script, because this code is executed twice.
  405.     if hasattr(sys, "setdefaultencoding"):
  406.         del sys.setdefaultencoding
  407.  
  408. main()
  409.  
  410. def _test():
  411.     print "sys.path = ["
  412.     for dir in sys.path:
  413.         print "    %r," % (dir,)
  414.     print "]"
  415.  
  416. if __name__ == '__main__':
  417.     _test()
  418.